Skip to main content
API docs by Redocly

Quantification and Analytics Tool (2.12.0)

Download OpenAPI specification:Download

FASP team: HSS_FASP_HQ@ghsc-psm.org URL: https://www.quantificationanalytics.org License: Apache 2.0

API's to access the QAT Server

budget

Get Budget list

Returns the complete list of Budgets List

Responses

Update Budget

API used to update a Budget

Request Body schema: application/json
required

The Budget object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
budgetId
integer <int32>
budgetCode
string
object (SimpleCodeObject)
object (FundingSource)
object (Label)
object (Currency)
budgetAmt
number <double>
budgetUsdAmt
number <double>
usedUsdAmt
number <double>
startDate
string <date-time>
stopDate
string <date-time>
notes
string
budgetUsable
boolean
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "budgetId": 0,
  • "budgetCode": "string",
  • "program": {
    },
  • "fundingSource": {
    },
  • "label": {
    },
  • "currency": {
    },
  • "budgetAmt": 0.1,
  • "budgetUsdAmt": 0.1,
  • "usedUsdAmt": 0.1,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "budgetUsable": true,
  • "baseModel": {
    }
}

Add Budget

API used to add a Budget to the Realm

Request Body schema: application/json
required

The Budget object that you want to add to the Realm

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
budgetId
integer <int32>
budgetCode
string
object (SimpleCodeObject)
object (FundingSource)
object (Label)
object (Currency)
budgetAmt
number <double>
budgetUsdAmt
number <double>
usedUsdAmt
number <double>
startDate
string <date-time>
stopDate
string <date-time>
notes
string
budgetUsable
boolean
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "budgetId": 0,
  • "budgetCode": "string",
  • "program": {
    },
  • "fundingSource": {
    },
  • "label": {
    },
  • "currency": {
    },
  • "budgetAmt": 0.1,
  • "budgetUsdAmt": 0.1,
  • "usedUsdAmt": 0.1,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "budgetUsable": true,
  • "baseModel": {
    }
}

Get Budget for a BudgetId

API used to get the Budget for a specific BudgetId

path Parameters
budgetId
required
integer <int32>

BudgetId that you want to the Budget for

Responses

Get Budget list for Program Ids

API used to get the Budget list for a list of Program Ids

Request Body schema: application/json
required

List of Program Ids that you want to the Budgets for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get Budget for a Realm

API used to get the Budget for a specific BudgetId

path Parameters
realmId
required
integer <int32>

RealmId that you want the List of Budgets for

Responses

commitRequest

Commit Request for Supply Plan

API used Part 1 of the Commit Request for Supply Plan.

path Parameters
comparedVersionId
required
integer <int32>

comparedVersionId that you want to commit supply plan for

Request Body schema: application/json
required
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programId
integer <int32>
programCode
string
object (RealmCountry)
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BasicUser)
programNotes
string
airFreightPerc
number <double>
seaFreightPerc
number <double>
plannedToSubmittedLeadTime
number <double>
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
shippedToArrivedByAirLeadTime
number <double>
shippedToArrivedBySeaLeadTime
number <double>
arrivedToDeliveredLeadTime
number <double>
object (SimpleObject)
object (SimpleObject)
notes
string
Array of objects (Region)
object (Version)
Array of objects (Version)
Array of objects (Consumption)
Array of objects (Inventory)
Array of objects (Shipment)
Array of objects (Batch)
Array of objects (ProblemReport)
Array of objects (SimplifiedSupplyPlan)
requestedProgramVersion
integer <int32>
Array of objects (SimplePlanningUnitForSupplyPlanObject)
Array of objects (SimpleCodeObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "programId": 0,
  • "programCode": "string",
  • "realmCountry": {
    },
  • "organisation": {
    },
  • "healthAreaList": [
    ],
  • "label": {
    },
  • "programManager": {
    },
  • "programNotes": "string",
  • "airFreightPerc": 0.1,
  • "seaFreightPerc": 0.1,
  • "plannedToSubmittedLeadTime": 0.1,
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "shippedToArrivedByAirLeadTime": 0.1,
  • "shippedToArrivedBySeaLeadTime": 0.1,
  • "arrivedToDeliveredLeadTime": 0.1,
  • "versionType": {
    },
  • "versionStatus": {
    },
  • "notes": "string",
  • "regionList": [
    ],
  • "currentVersion": {
    },
  • "versionList": [
    ],
  • "consumptionList": [
    ],
  • "inventoryList": [
    ],
  • "shipmentList": [
    ],
  • "batchInfoList": [
    ],
  • "problemReportList": [
    ],
  • "supplyPlan": [
    ],
  • "requestedProgramVersion": 0,
  • "planningUnitList": [
    ],
  • "procurementAgentList": [
    ],
  • "baseModel": {
    }
}

Commit Request for Datatse

API used Part 1 of the Commit Request for Dataset.

path Parameters
comparedVersionId
required
integer <int32>

comparedVersionId that you want to commit dataset for

Responses

Get Commit Request list

API used get supply plan commit request list .

path Parameters
requestStatus
required
integer <int32>

requestStatus that you want to commit request list for

Request Body schema: application/json
required
startDate
string <date-time>
stopDate
string <date-time>
programIds
Array of strings
programIdsString
string
startDateString
string
stopDateString
string

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "programIds": [
    ],
  • "programIdsString": "string",
  • "startDateString": "string",
  • "stopDateString": "string"
}

send notification for commit

API used to send notification once commit is success.

path Parameters
commitRequestId
required
integer <int32>

commitRequestId that you want to send notofication for

Responses

country

Get active Country list

API used to get the complete Country list. Will only return those Countries that are marked Active.

Responses

Update Country

API used to update a Country

Request Body schema: application/json
required

The Country object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
countryId
integer <int32>
countryCode
string
countryCode2
string
object (Label)
object (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "countryId": 0,
  • "countryCode": "string",
  • "countryCode2": "string",
  • "label": {
    },
  • "currency": {
    },
  • "baseModel": {
    }
}

Add Country

API used to add a Country

Request Body schema: application/json
required

The Country object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
countryId
integer <int32>
countryCode
string
countryCode2
string
object (Label)
object (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "countryId": 0,
  • "countryCode": "string",
  • "countryCode2": "string",
  • "label": {
    },
  • "currency": {
    },
  • "baseModel": {
    }
}

Get Country for a CountryId

API used to get the Country for a specific CountryId

path Parameters
countryId
required
integer <int32>

CountryId that you want to the Country for

Responses

Get Country list

API used to get the complete Country list.

Responses

currency

Get active Currency list

API used to get the complete Currency list. Will only return those Currencies that are marked Active.

Responses

Update Currency

API used to update a Currency

Request Body schema: application/json
required

The Currency object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
currencyId
integer <int32>
currencyCode
string
object (Label)
conversionRateToUsd
number <double>
isSync
boolean
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "currencyId": 0,
  • "currencyCode": "string",
  • "label": {
    },
  • "conversionRateToUsd": 0.1,
  • "isSync": true,
  • "baseModel": {
    }
}

Add Currency

API used to add a Currency

Request Body schema: application/json
required

The Currency object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
currencyId
integer <int32>
currencyCode
string
object (Label)
conversionRateToUsd
number <double>
isSync
boolean
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "currencyId": 0,
  • "currencyCode": "string",
  • "label": {
    },
  • "conversionRateToUsd": 0.1,
  • "isSync": true,
  • "baseModel": {
    }
}

Get Currency for a CurrencyId

API used to get the Currency for a specific CurrencyId

path Parameters
currencyId
required
integer <int32>

CurrencyId that you want to the Currency for

Responses

Get Currency list

API used to get the complete Currency list.

Responses

dashboard

Application level dashboard

API used to get data for application level dashboard

Responses

Realm level dashboard

API used to get data for realm level dashboard

Responses

Supply plan reviewer level dashboard

API used to get data for supply plan reviewer level dashboard

Responses

Application level admin user list

API used to get user list for application level admin

Responses

Realm level admin user list

API used to get user list for realm level admin

Responses

dataSource

Get active DataSource list

API used to get the complete DataSource list. Will only return those DataSources that are marked Active.

Responses

Update DataSource

API used to update a DataSource

Request Body schema: application/json
required

The DataSource object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
dataSourceId
integer <int32>
object (SimpleCodeObject)
object (SimpleCodeObject)
object (Label)
object (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "dataSourceId": 0,
  • "realm": {
    },
  • "program": {
    },
  • "label": {
    },
  • "dataSourceType": {
    },
  • "baseModel": {
    }
}

Add DataSource

API used to add a DataSource

Request Body schema: application/json
required

The DataSource object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
dataSourceId
integer <int32>
object (SimpleCodeObject)
object (SimpleCodeObject)
object (Label)
object (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "dataSourceId": 0,
  • "realm": {
    },
  • "program": {
    },
  • "label": {
    },
  • "dataSourceType": {
    },
  • "baseModel": {
    }
}

Get DataSource for a DataSourceId

API used to get the DataSource for a specific DataSourceId

path Parameters
dataSourceId
required
integer <int32>

DataSourceId that you want to the DataSource for

Responses

Get DataSource list

API used to get the complete DataSource list.

Responses

Get DataSource for RealmId and ProgramId

API used to get the DataSource for a specific RealmId and ProgramId

path Parameters
realmId
required
integer <int32>

RealmId that you want to the DataSource for

programId
required
integer <int32>

ProgramId that you want to the DataSource for

Responses

Get DataSource for a DataSourceTypeId

API used to get the DataSource for a specific DataSourceTypeId

path Parameters
dataSourceTypeId
required
integer <int32>

DataSourceTypeId that you want to the DataSource for

Responses

dataSourceType

Get active DataSourceType list

API used to get the complete DataSourceType list. Will only return those DataSourceTypes that are marked Active.

Responses

Update DataSourceType

API used to update a DataSourceType

Request Body schema: application/json
required

The DataSourceType object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
dataSourceTypeId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "dataSourceTypeId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "baseModel": {
    }
}

Add DataSourceType

API used to add a DataSourceType

Request Body schema: application/json
required

The DataSourceType object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
dataSourceTypeId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "dataSourceTypeId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "baseModel": {
    }
}

Get DataSourceType for a DataSourceTypeId

API used to get the DataSourceType for a specific DataSourceTypeId

path Parameters
dataSourceTypeId
required
integer <int32>

DataSourceTypeId that you want to the DataSourceType for

Responses

Get DataSourceType list

API used to get the complete DataSourceType list.

Responses

Get DataSourceType for a realmId

API used to get the DataSourceType for a specific realmId

path Parameters
realmId
required
integer <int32>

RealmId that you want to the DataSourceType for

Responses

dataset

Get dataset list for programId and versionId

API used to get the dataset list for specific programId and versionId.

path Parameters
programId
required
integer <int32>

programId that you want to the dataset list for

versionId
required
integer <int32>

versionId that you want to the dataset list for

Responses

Get dataset list for multiple programId and versionId

API used to get the dataset list for multiple programId and versionId.

Request Body schema: application/json
required

map of programVersionList that you want to the dataset list for

Array
programId
integer <int32>
versionId
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get active dataset list

API used to get the complete dataset list. Will only return those datasets that are marked Active.

Responses

Update dataset

API used to update a dataset

Request Body schema: application/json
required

The dataset object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programId
integer <int32>
programCode
string
object (RealmCountry)
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BasicUser)
programNotes
string
airFreightPerc
number <double>
seaFreightPerc
number <double>
plannedToSubmittedLeadTime
number <double>
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
shippedToArrivedByAirLeadTime
number <double>
shippedToArrivedBySeaLeadTime
number <double>
arrivedToDeliveredLeadTime
number <double>
programTypeId
integer <int32>
Array of objects (Region)
object (Version)
Array of objects (Version)
healthAreaArray
Array of strings
regionArray
Array of strings
healthAreaIdList
Array of integers <int32> [ items <int32 > ]
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "programId": 0,
  • "programCode": "string",
  • "realmCountry": {
    },
  • "organisation": {
    },
  • "healthAreaList": [
    ],
  • "label": {
    },
  • "programManager": {
    },
  • "programNotes": "string",
  • "airFreightPerc": 0.1,
  • "seaFreightPerc": 0.1,
  • "plannedToSubmittedLeadTime": 0.1,
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "shippedToArrivedByAirLeadTime": 0.1,
  • "shippedToArrivedBySeaLeadTime": 0.1,
  • "arrivedToDeliveredLeadTime": 0.1,
  • "programTypeId": 0,
  • "regionList": [
    ],
  • "currentVersion": {
    },
  • "versionList": [
    ],
  • "healthAreaArray": [
    ],
  • "regionArray": [
    ],
  • "healthAreaIdList": [
    ],
  • "baseModel": {
    }
}

Get dataset list for programId

API used to get the dataset list for specific programId.

path Parameters
programId
required
integer <int32>

programId that you want to dataset list for

Responses

Get dataset list

API used to get the complete dataset list.

Responses

Get dataset list for realm

API used to get the dataset list for specific realm.

path Parameters
realmId
required
integer <int32>

realmId that you want to dataset list for

Responses

Get planning unit list for programId and versionId

API used to get the planning unit list for specific programId and versionId.

path Parameters
programId
required
integer <int32>

programId that you want to the planning unit list for

versionId
required
integer <int32>

versionId that you want to the planning unit list for

Responses

Load Datatse

API used to load Dataset.

Responses

List five versions of program from given page number for specified programId

API used to list five versions of dataset from given page number for specified programId

path Parameters
programId
required
integer <int32>

programId that you want to get dataset list for

page
required
integer <int32>

number that you want to get dataset list from

Responses

datatset

Add datatset

API used to add a datatset

Request Body schema: application/json
required

The dataset object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programId
integer <int32>
programCode
string
object (RealmCountry)
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BasicUser)
programNotes
string
airFreightPerc
number <double>
seaFreightPerc
number <double>
plannedToSubmittedLeadTime
number <double>
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
shippedToArrivedByAirLeadTime
number <double>
shippedToArrivedBySeaLeadTime
number <double>
arrivedToDeliveredLeadTime
number <double>
programTypeId
integer <int32>
Array of objects (Region)
object (Version)
Array of objects (Version)
healthAreaArray
Array of strings
regionArray
Array of strings
healthAreaIdList
Array of integers <int32> [ items <int32 > ]
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "programId": 0,
  • "programCode": "string",
  • "realmCountry": {
    },
  • "organisation": {
    },
  • "healthAreaList": [
    ],
  • "label": {
    },
  • "programManager": {
    },
  • "programNotes": "string",
  • "airFreightPerc": 0.1,
  • "seaFreightPerc": 0.1,
  • "plannedToSubmittedLeadTime": 0.1,
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "shippedToArrivedByAirLeadTime": 0.1,
  • "shippedToArrivedBySeaLeadTime": 0.1,
  • "arrivedToDeliveredLeadTime": 0.1,
  • "programTypeId": 0,
  • "regionList": [
    ],
  • "currentVersion": {
    },
  • "versionList": [
    ],
  • "healthAreaArray": [
    ],
  • "regionArray": [
    ],
  • "healthAreaIdList": [
    ],
  • "baseModel": {
    }
}

dimension

Get active Dimension list

API used to get the complete Dimension list. Will only return those Dimensions that are marked Active.

Responses

Update Dimension

API used to update a Dimension

Request Body schema: application/json
required

The Dimension object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
dimensionId
integer <int32>
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "dimensionId": 0,
  • "label": {
    },
  • "baseModel": {
    }
}

Add Dimension

API used to add a Dimension

Request Body schema: application/json
required

The Dimension object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
dimensionId
integer <int32>
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "dimensionId": 0,
  • "label": {
    },
  • "baseModel": {
    }
}

Get Dimension for a DimensionId

API used to get the Dimension for a specific DimensionId

path Parameters
dimensionId
required
integer <int32>

DimensionId that you want to the Dimension for

Responses

Get Dimension list

API used to get the complete Dimension list.

Responses

equivalencyUnit

Get active EquivalencyUnit list

API used to get the complete EquivalencyUnit list. Will only return those EquivalencyUnits that are marked Active.

Responses

Add or Update EquivalencyUnit

API used to add or update EquivalencyUnit

Request Body schema: application/json
required

The list of EquivalencyUnit objects that you want to add or update. If equivalencyUnitId is null or 0 then it is added if equivalencyUnitId is not null and non 0 it is updated

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
equivalencyUnitId
integer <int32>
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get complete EquivalencyUnit list

API used to get the complete EquivalencyUnit list.

Responses

equivalencyUnitMapping, equivalencyUnit

Get active EquivalencyUnitMapping list

API used to get the complete EquivalencyUnitMapping list. Will only return those EquivalencyUnitMappings that are marked Active.

Responses

Add or Update EquivalencyUnitMapping

API used to add or update EquivalencyUnitMapping

Request Body schema: application/json
required

The list of EquivalencyUnitMapping objects that you want to add or update. If equivalencyUnitMappingId is null or 0 then it is added if equivalencyUnitMappingId is not null and non 0 it is updated

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
equivalencyUnitMappingId
integer <int32>
object (EquivalencyUnit)
object (SimpleObject)
object (SimpleCodeObject)
object (SimpleObject)
convertToEu
number <double>
notes
string
object (SimpleCodeObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get list of EquivalencyUnitMapping

API used to get the list of Equivalency Units Mapping based on a Program and a Forecasting Unit

path Parameters
forecastingUnitId
required
integer <int32>

The Forecasting Unit Id that you want the list of EUM for

programId
required
integer <int32>

The Program Id that you want the priority for

Responses

Get complete EquivalencyUnitMapping list

API used to get the complete EquivalencyUnitMapping list.

Responses

file

Get file from Server

Returns the byte stream of the file that was requested

path Parameters
fileName
required
string

Name of file that the user wants to get from the Server

Responses

forecastMethod

Get active ForecastMethod list

API used to get the complete ForecastMethod list. Will only return those ForecastMethods that are marked Active.

Responses

Add or Update ForecastMethod

API used to add or update ForecastMethod

Request Body schema: application/json
required

The list of ForecastMethod objects that you want to add or update. If forecastMethodId is null or 0 then it is added if forecastMethodId is not null and non 0 it is updated

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
forecastMethodId
integer <int32>
forecastMethodTypeId
integer <int32>
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get complete ForecastMethod list

API used to get the complete ForecastMethod list.

Responses

usageType

Get active UsageType list

API used to get the complete UsageType list. Will only return those UsageTypes that are marked Active.

Responses

nodeType

Get active NodeType list

API used to get the complete NodeType list. Will only return those NodeTypes that are marked Active.

Responses

forecastMethodType

Get active ForecastMethodType list

API used to get the complete ForecastMethodType list. Will only return those ForecastMethodTypes that are marked Active.

Responses

forecastingStatisctic

Get forecasting statistic data for arima

API used to get forecasting statistic data for arima

Responses

Get forecasting statistic data for tes

API used to get forecasting statistic data for tes

Responses

Get forecasting statistic data for regression

API used to get forecasting statistic data for regression

Responses

forecastingUnit

Get active ForecastingUnit list

API used to get the complete ForecastingUnit list. Will only return those ForecastingUnits that are marked Active.

Responses

Update ForecastingUnit

API used to update a ForecastingUnit

Request Body schema: application/json
required

The ForecastingUnit object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
forecastingUnitId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (Label)
object (SimpleObject)
object (SimpleObject)
object (SimpleCodeObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "forecastingUnitId": 0,
  • "realm": {
    },
  • "genericLabel": {
    },
  • "label": {
    },
  • "productCategory": {
    },
  • "tracerCategory": {
    },
  • "unit": {
    },
  • "baseModel": {
    }
}

Add ForecastingUnit

API used to add a ForecastingUnit

Request Body schema: application/json
required

The ForecastingUnit object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
forecastingUnitId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (Label)
object (SimpleObject)
object (SimpleObject)
object (SimpleCodeObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "forecastingUnitId": 0,
  • "realm": {
    },
  • "genericLabel": {
    },
  • "label": {
    },
  • "productCategory": {
    },
  • "tracerCategory": {
    },
  • "unit": {
    },
  • "baseModel": {
    }
}

Get ForecastingUnit for a ForecastingUnitId

API used to get the ForecastingUnit for a specific ForecastingUnitId

path Parameters
forecastingUnitId
required
integer <int32>

ForecastingUnitId that you want to the ForecastingUnit for

Responses

Get ForecastingUnit list

API used to get the complete ForecastingUnit list.

Responses

Get ForecastingUnit for a RealmId

API used to get all the ForecastingUnits for a specific RealmId

path Parameters
realmId
required
integer <int32>

RealmId that you want to the ForecastingUnit for

Responses

Get ForecastingUnit for a multiple tracer categories

API used to get forecastingUnits for multiple tracer categories

Request Body schema: application/json
required

array of tracerCategoryIds that you want to the ForecastingUnit for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get ForecastingUnit for a tracer category

API used to get forecastingUnits for a specific tracer category

path Parameters
tracerCategoryId
required
integer <int32>

TracerCategoryId that you want to the ForecastingUnit for

Responses

Get forecasting unit for specific ProgramId and versionId

API used to get the forecasting unit for a specific ProgramId and versionId

path Parameters
programId
required
integer <int32>

programId that you want to the forecasting unit for

versionId
required
integer <int32>

versionId that you want to the forecasting unit for

Responses

fundingSource

Get FundingSource for a FundingSourceId

API used to get the FundingSource for a specific FundingSourceId

path Parameters
fundingSourceId
required
integer <int32>

FundingSourceId that you want to the FundingSource for

Responses

Get FundingSource list

API used to get the complete FundingSource list.

Responses

Update FundingSource

API used to update a FundingSource

Request Body schema: application/json
required

The FundingSource object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
fundingSourceId
integer <int32>
fundingSourceCode
string
object (Label)
object (SimpleCodeObject)
allowedInBudget
boolean
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "fundingSourceId": 0,
  • "fundingSourceCode": "string",
  • "label": {
    },
  • "realm": {
    },
  • "allowedInBudget": true,
  • "baseModel": {
    }
}

Add FundingSource

API used to add a FundingSource

Request Body schema: application/json
required

The FundingSource object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
fundingSourceId
integer <int32>
fundingSourceCode
string
object (Label)
object (SimpleCodeObject)
allowedInBudget
boolean
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "fundingSourceId": 0,
  • "fundingSourceCode": "string",
  • "label": {
    },
  • "realm": {
    },
  • "allowedInBudget": true,
  • "baseModel": {
    }
}

Get FundingSource by display name

API used to get the complete FundingSource by providing the display name of the FundingSource and the Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want to the FundingSource for

name
required
string

Display name that you want to the FundingSource for

Responses

Get FundingSource list for Realm

API used to get the complete FundingSource list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want to the FundingSource for

Responses

healthArea

Get HealthArea list

API used to get the complete HealthArea list.

Responses

Update HealthArea

API used to update a HealthArea

Request Body schema: application/json
required

The HealthArea object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
healthAreaId
integer <int32>
object (SimpleCodeObject)
object (Label)
healthAreaCode
string
realmCountryArray
Array of strings
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "healthAreaId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "healthAreaCode": "string",
  • "realmCountryArray": [
    ],
  • "baseModel": {
    }
}

Add HealthArea

API used to add a HealthArea

Request Body schema: application/json
required

The HealthArea object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
healthAreaId
integer <int32>
object (SimpleCodeObject)
object (Label)
healthAreaCode
string
realmCountryArray
Array of strings
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "healthAreaId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "healthAreaCode": "string",
  • "realmCountryArray": [
    ],
  • "baseModel": {
    }
}

Get HealthArea for a HealthAreaId

API used to get the HealthArea for a specific HealthAreaId

path Parameters
healthAreaId
required
integer <int32>

HealthAreaId that you want to the HealthArea for

Responses

Get HealthArea list for Realm

API used to get the complete HealthArea list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the HealthArea list for

Responses

Get HealthArea list for RealmCountry

API used to get the complete HealthArea list for a RealmCountry

path Parameters
realmCountryId
required
integer <int32>

RealmCountryId that you want to the HealthArea list for

Responses

Get HealthArea list for active Programs

API used to get the complete HealthArea list that are linked to active Programs

Responses

Get HealthArea list for active Programs

API used to get the complete HealthArea list that are linked to active Programs

path Parameters
realmId
required
integer <int32>

RealmId that you want to the HealthArea list for

Responses

Get HealthArea by display name

API used to get the complete HealthArea by providing the display name of the HealthArea and the Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want to the HealthArea for

name
required
string

Display name that you want to the HealthArea for

Responses

integrationProgram

Get Integration Program list

API used to get the complete Integration Program list.

Responses

Update IntegrationProgram

API used to update an IntegrationProgram

Request Body schema: application/json
required

An array of Integration Program objects that you want to update

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
integrationProgramId
integer <int32>
object (Integration)
object (SimpleObject)
object (SimpleObject)
object (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Integration Programs for an IntegrationProgramId

API used to get the Integration Programs for a specific IntegrationProgramId

path Parameters
integrationProgramId
required
integer <int32>

IntegrationProgramId that you want to the Integration Program for

Responses

Get Integration Program list for a ProgramId

API used to get the complete Integration Program list for a ProgramId.

path Parameters
programId
required
integer <int32>

programId that you want to the Integration Program list for

Responses

integration

Get Integration for an IntegrationId

API used to get the Integration for a specific IntegrationId

path Parameters
integrationId
required
integer <int32>

IntegrationId that you want to the Integration for

Responses

Get Integration list

API used to get the complete Integration list.

Responses

Update Integration

API used to update an Integration

Request Body schema: application/json
required

The Integration object that you want to update

integrationId
integer <int32>
integrationName
string
object (SimpleObject)
folderLocation
string
fileName
string
object (IntegrationView)

Responses

Request samples

Content type
application/json
{
  • "integrationId": 0,
  • "integrationName": "string",
  • "realm": {
    },
  • "folderLocation": "string",
  • "fileName": "string",
  • "integrationView": {
    }
}

Add Integration

API used to add an Integration

Request Body schema: application/json
required

The Integration object that you want to add

integrationId
integer <int32>
integrationName
string
object (SimpleObject)
folderLocation
string
fileName
string
object (IntegrationView)

Responses

Request samples

Content type
application/json
{
  • "integrationId": 0,
  • "integrationName": "string",
  • "realm": {
    },
  • "folderLocation": "string",
  • "fileName": "string",
  • "integrationView": {
    }
}

Get Integration View list

API used to get the complete Integration View list.

Responses

jiraServiceDesk

Sync user's Jira account id

API used to sync user's Jira account id in user table.

Responses

Add issue in Jira

API used to add issue in Jira

Request Body schema: application/json
required

Issue details to add in Jira in json format

string

Responses

Request samples

Content type
application/json
"string"

Add attachment in Jira issue

API used to add attachment in the issue in Jira

path Parameters
issueId
required
string

Issue id for which attachment needs to be added for

Request Body schema: application/json

Attachment which needs to be added in Jira issue

file
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Get number of open and addressed issues

API used to get number of open and addressed issues

Responses

language

Get Language list

API used to get the Language list. Returns only those Languages that are marked as Active

Responses

Update Language

API used to update a Language

Request Body schema: application/json
required

The Language object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
languageId
integer <int32>
object (Label)
languageCode
string
countryCode
string
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "languageId": 0,
  • "label": {
    },
  • "languageCode": "string",
  • "countryCode": "string",
  • "baseModel": {
    }
}

Add Language

API used to add a Language

Request Body schema: application/json
required

The Language object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
languageId
integer <int32>
object (Label)
languageCode
string
countryCode
string
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "languageId": 0,
  • "label": {
    },
  • "languageCode": "string",
  • "countryCode": "string",
  • "baseModel": {
    }
}

Get Language for a LanguageId

API used to get the Language for a specific LanguageId

path Parameters
languageId
required
integer <int32>

LanguageId that you want to the Language for

Responses

Get Language list

API used to get the complete Language list.

Responses

locale

Get the language json for static labels

API used to get the language json for static labels.

path Parameters
languageCode
required
string

Responses

modelingType

Get active ModelingType list

API used to get the complete ModelingType list. Will only return those ModelingTypes that are marked Active.

Responses

Add or Update ModelingType

API used to add or update ModelingType

Request Body schema: application/json
required
Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
modelingTypeId
integer <int32>
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get complete ModelingType list

API used to get the complete ModelingType list.

Responses

organisation

Get Organisation list

API used to get the complete Organisation list.

Responses

Update Organisation

API used to update an Organisation

Request Body schema: application/json
required

The Organisation object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
organisationId
integer <int32>
organisationCode
string
object (SimpleCodeObject)
object (SimpleObject)
object (Label)
realmCountryArray
Array of strings
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "organisationId": 0,
  • "organisationCode": "string",
  • "realm": {
    },
  • "organisationType": {
    },
  • "label": {
    },
  • "realmCountryArray": [
    ],
  • "baseModel": {
    }
}

Add Organisation

API used to add an Organisation

Request Body schema: application/json
required

The Organisation object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
organisationId
integer <int32>
organisationCode
string
object (SimpleCodeObject)
object (SimpleObject)
object (Label)
realmCountryArray
Array of strings
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "organisationId": 0,
  • "organisationCode": "string",
  • "realm": {
    },
  • "organisationType": {
    },
  • "label": {
    },
  • "realmCountryArray": [
    ],
  • "baseModel": {
    }
}

Get Organisation for a OrganisationId

API used to get the Organisation for a specific OrganisationId

path Parameters
organisationId
required
integer <int32>

OrganisationId that you want to the Organisation for

Responses

Get Organisation list for Realm

API used to get the complete Organisation list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the Organisation list for

Responses

Get Organisation list for RealmCountry

API used to get the complete Organisation list for a RealmCountry

path Parameters
realmCountryId
required
integer <int32>

RealmCountryId that you want to the Organisation list for

Responses

Get Organisation by display name

API used to get the complete Organisation by providing the display name of the Organisation and the Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want to the Organisation for

name
required
string

Display name that you want to the Organisation for

Responses

organisationType

Get Organisation for a OrganisationTypeId

API used to get the Organisation type for a specific OrganisationId

path Parameters
organisationTypeId
required
integer <int32>

OrganisationTypeId that you want to the Organisation type for

Responses

Get Active Organisation type list

API used to get the Organisation type list that are active.

Responses

Update Organisation Type

API used to update an Organisation type

Request Body schema: application/json
required

The OrganisationType object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
organisationTypeId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "organisationTypeId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "baseModel": {
    }
}

Add Organisation Type

API used to add an Organisation Type

Request Body schema: application/json
required

The OrganisationType object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
organisationTypeId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "organisationTypeId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "baseModel": {
    }
}

Get complete Organisation type list

API used to get the complete Organisation type list.

Responses

Get Organisation type list for Realm

API used to get the complete Organisation type list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the Organisation type list for

Responses

pipeline

Get QAT Temp Program

API used to get pipeline program data from QAT temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to temp program data for

Responses

Save Pipeline Program Data

API used to save pipeline program data into QAT temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to save program for

Request Body schema: application/json
required

Program object which you need to save in temp table

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programId
integer <int32>
programCode
string
object (RealmCountry)
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BasicUser)
programNotes
string
airFreightPerc
number <double>
seaFreightPerc
number <double>
plannedToSubmittedLeadTime
number <double>
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
shippedToArrivedByAirLeadTime
number <double>
shippedToArrivedBySeaLeadTime
number <double>
arrivedToDeliveredLeadTime
number <double>
monthsInPastForAmc
integer <int32>
monthsInFutureForAmc
integer <int32>
shelfLife
number <double>
Array of objects (Region)
regionArray
Array of strings
object (Version)
Array of objects (Version)
healthAreaArray
Array of strings
healthAreaIdList
Array of integers <int32> [ items <int32 > ]
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "programId": 0,
  • "programCode": "string",
  • "realmCountry": {
    },
  • "organisation": {
    },
  • "healthAreaList": [
    ],
  • "label": {
    },
  • "programManager": {
    },
  • "programNotes": "string",
  • "airFreightPerc": 0.1,
  • "seaFreightPerc": 0.1,
  • "plannedToSubmittedLeadTime": 0.1,
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "shippedToArrivedByAirLeadTime": 0.1,
  • "shippedToArrivedBySeaLeadTime": 0.1,
  • "arrivedToDeliveredLeadTime": 0.1,
  • "monthsInPastForAmc": 0,
  • "monthsInFutureForAmc": 0,
  • "shelfLife": 0.1,
  • "regionList": [
    ],
  • "regionArray": [
    ],
  • "currentVersion": {
    },
  • "versionList": [
    ],
  • "healthAreaArray": [
    ],
  • "healthAreaIdList": [
    ],
  • "baseModel": {
    }
}

Get Pipeline Program List

API used to get pipeline program list from adb table

Responses

Get Pipeline Shipment Data

API used to get pipeline shipment data by pipelineId

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need shipment data for

Responses

Save Shipment Data For Program

API used to save shipment for specified program into temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need shipment to save for

Request Body schema: application/json
required

Array of shipments which needs to be saved

Array
shipmentId
integer <int32>
planningUnit
string
expectedDeliveryDate
string <date-time>
suggestedQty
number <double>
procurementAgent
string
procurementUnit
string
supplier
string
quantity
number <double>
rate
number <double>
productCost
number <double>
shipmentMode
string
freightCost
number <double>
plannedDate
string <date-time>
submittedDate
string <date-time>
approvedDate
string <date-time>
shippedDate
string <date-time>
arrivedDate
string <date-time>
receivedDate
string <date-time>
shipmentStatus
string
notes
string
dataSource
string
accountFlag
boolean
erpFlag
boolean
versionId
integer <int32>
fundingSource
string
active
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get List of Planning Unit Inventory Count

API used to get list of planning unit inventory count from temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need the list of planning unit inventory count for

Responses

Save Final Program Data

API used to save final program data into QAT tables from temp table for specified pipelineId

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need program data to save for

Responses

Save Planning Unit For Realm Country

API used to save planning unit for specified realm country

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need planning unit to save for

realmCountryId
required
integer <int32>

realmCountryId for which you need planning unit to save for

Responses

Get Planning Unit List

API used to get planning unit list from adb tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to planning unit list for

Responses

Save Pipeline Data

API used to save pipeline db data in to QAT adb(access database) tables

path Parameters
fileName
required
string

Filename to save in database

Request Body schema: application/json
required

Pipeline object which you need to save in adb tables

Array of objects (PplCommodityprice)
Array of objects (PplConsumption)
Array of objects (PplDatasource)
Array of objects (PplFundingsource)
Array of objects (PplInventory)
Array of objects (PplMethod)
Array of objects (PplMonthlystockarchive)
Array of objects (PplPasterrors)
Array of objects (PplProduct)
Array of objects (PplProductfreightcost)
Array of objects (PplProductsuppliercasesize)
Array of objects (PplPrograminfo)
Array of objects (PplShipment)
Array of objects (PplSource)
Array of objects (PplTblbe_version)
Array of objects (PplTblimportproducts)
Array of objects (PplTblimportrecords)

Responses

Request samples

Content type
application/json
{
  • "commodityprice": [
    ],
  • "consumption": [
    ],
  • "datasource": [
    ],
  • "fundingsource": [
    ],
  • "inventory": [
    ],
  • "method": [
    ],
  • "monthlystockarchive": [
    ],
  • "paste_errors": [
    ],
  • "product": [
    ],
  • "productfreightcost": [
    ],
  • "productsuppliercasesize": [
    ],
  • "programinfo": [
    ],
  • "shipment": [
    ],
  • "source": [
    ],
  • "tblbe_version": [
    ],
  • "tblimportproducts": [
    ],
  • "tblimportrecords": [
    ]
}

Get Pipeline Program Info

API used to get pipeline program info by pipelineId

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need program info for

Responses

Save Planning Unit For Program

API used to save planning unit for specified program into temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need planning units to save for

Request Body schema: application/json
required

Array of planning unit which needs to be saved

Array
programPlanningUnitId
string
object (SimpleObject)
planningUnitId
string
multiplier
number <double>
reorderFrequencyInMonths
integer <int32>
minMonthsOfStock
integer <int32>
productCategoryId
integer <int32>
pipelineProductName
string
pipelineProductCategoryName
string
localProcurmentLeadTime
number <double>
shelfLife
integer <int32>
catalogPrice
number <double>
monthsInPastForAmc
integer <int32>
monthsInFutureForAmc
integer <int32>
active
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get QAT Temp Planning Unit List

API used to get planning unit list from temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to planning unit list for

Responses

Get Consumtion Data

API used to get consumption data from adb tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to consumption data for

Responses

Save Consumption For Program

API used to save consumption for specified program into temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need consumption to save for

Request Body schema: application/json
required

Array of consumption which needs to be saved

Array
consumptionId
integer <int32>
regionId
string
planningUnitId
string
consumptionDate
string
actualFlag
boolean
consumptionQty
number <double>
dayOfStockOut
integer <int32>
dataSourceId
string
consNumMonth
integer <int32>
notes
string
realmCountryPlanningUnitId
integer <int32>
multiplier
number <double>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Program Region

API used to get program region from temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to program region for

Responses

Get Consumtion List

API used to get consumption data from adb tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to consumption list for

Responses

Get Pipeline Inventory Data

API used to get pipeline inventory data from adb or temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need to pipeline inventory data for

Responses

Save Inventory Data For Program

API used to save inventory for specified program into temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need inventory to save for

Request Body schema: application/json
required

Array of inventory which needs to be saved

Array
planningUnitId
string
dataSourceId
string
regionId
string
inventoryDate
string
inventory
integer <int64>
manualAdjustment
integer <int64>
notes
string
active
boolean
realmCountryPlanningUnitId
integer <int32>
multiplier
number <double>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Save QAT Temp Data Source

API used to save data source for specified program into temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need data source to save for

Request Body schema: application/json
required

Array of data source which needs to be saved

Array
dataSourceId
integer <int32>
dataSourceTypeId
integer <int32>
pipelineDataSourceType
string
pipelineDataSource
string
pipelineDataSourceId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get List of Data Source

API used to get list of data source from temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need the list of data source for

Responses

Save QAT Temp Funding Source

API used to save funding source for specified program into temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need funding source to save for

Request Body schema: application/json
required

Array of funding source which needs to be saved

Array
fundingSourceId
integer <int32>
pipelineFundingSource
string
pipelineFundingSourceId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get List of Funding Source

API used to get list of funding source from temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need the list of funding source for

Responses

Save QAT Temp Procurement Agent

API used to save procurement agent for specified program into temp table

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need procurement agent to save for

Request Body schema: application/json
required

Array of procurement agent which needs to be saved

Array
procurementAgentId
integer <int32>
pipelineProcurementAgent
string
pipelineProcurementAgentId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get List of Procurement Agent

API used to get list of procurement agent from temp tables

path Parameters
pipelineId
required
integer <int32>

PipelineId for which you need the list of procurement agent for

Responses

planningUnit

Get active PlanningUnit list

API used to get the list of active PlanningUnits.

Responses

Update PlanningUnit

API used to update a PlanningUnit

Request Body schema: application/json
required

The PlanningUnit object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
planningUnitId
integer <int32>
object (ForecastingUnit)
object (Label)
object (SimpleCodeObject)
multiplier
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "planningUnitId": 0,
  • "forecastingUnit": {
    },
  • "label": {
    },
  • "unit": {
    },
  • "multiplier": 0.1,
  • "baseModel": {
    }
}

Add PlanningUnit

API used to add a PlanningUnit

Request Body schema: application/json
required

The PlanningUnit object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
planningUnitId
integer <int32>
object (ForecastingUnit)
object (Label)
object (SimpleCodeObject)
multiplier
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "planningUnitId": 0,
  • "forecastingUnit": {
    },
  • "label": {
    },
  • "unit": {
    },
  • "multiplier": 0.1,
  • "baseModel": {
    }
}

Get PlanningUnit for a PlanningUnitId

API used to get the PlanningUnit for a specific PlanningUnitId

path Parameters
planningUnitId
required
integer <int32>

PlanningUnitId that you want to the PlanningUnit for

Responses

Get a complete PlanningUnitCapacity list

API used to get a complete PlanningUnitCapacity list

Responses

Get PlanningUnitCapacity list for a PlanningUnitId and a given date range

API used to get PlanningUnitCapacity list for a PlanningUnitId and a given date range

path Parameters
planningUnitId
required
integer <int32>

planningUnitId that you want a PlanningUnitCapacity list for

startDate
required
string

startDate the date you want the PlanningUnitCapacity data from

stopDate
required
string

stopDate the date you want the PlanningUnitCapacity data till

Responses

Get PlanningUnitCapacity list for a PlanningUnitId

API used to get PlanningUnitCapacity list for a PlanningUnitId

path Parameters
planningUnitId
required
integer <int32>

planningUnitId that you want a PlanningUnitCapacity list for

Responses

Update PlanningUnitCapacity

API used to update PlanningUnitCapacity

Request Body schema: application/json
required

planningUnitCapacity objects that you want to update

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
planningUnitCapacityId
integer <int32>
object (SimpleObject)
object (SimpleObject)
startDate
string
stopDate
string
capacity
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get PlanningUnit list

API used to get the complete PlanningUnit list.

Responses

Get active PlanningUnit list for Realm

API used to get the list of active PlanningUnits for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the PlanningUnit list for

Responses

Get PlanningUnit list for Realm

API used to get the complete PlanningUnit list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the PlanningUnit list for

Responses

Get a PlanningUnit list for forecastingUnitId

API used to get a PlanningUnit list for forecastingUnitId

path Parameters
forecastingUnitId
required
integer <int32>

ForecastingUnitId that you want the planning unit list for

Responses

Get PlanningUnitCapacity for a Realm and a given date range

API used to get PlanningUnitCapacity for a Realm and a given date range

path Parameters
realmId
required
integer <int32>

realmId that you want a PlanningUnitCapacity from

startDate
required
string

startDate the date you want the PlanningUnitCapacity data from

stopDate
required
string

stopDate the date you want the PlanningUnitCapacity data till

Responses

Get PlanningUnitCapacity for a Realm

API used to get PlanningUnitCapacity for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want a PlanningUnitCapacity from

Responses

Get PlanningUnit list for ProductCategory

API used to get the complete PlanningUnit list for a ProductCategory

path Parameters
productCategoryId
required
integer <int32>

productCategoryId that you want the PlanningUnit list for

Responses

Get active PlanningUnit list for ProductCategory

API used to get the list of active PlanningUnits for a ProductCategory

path Parameters
productCategoryId
required
integer <int32>

productCategoryId that you want the PlanningUnit list for

Responses

Get active PlanningUnit list for ProductCategory

API used to get the list of active PlanningUnits for a ProductCategory

Request Body schema: application/json
required

array of productCategoryIds that you want the PlanningUnit

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

The procurement agent PlanningUnits list

API used to get the procurement agent PlanningUnits list

path Parameters
planningUnitId
required
integer <int32>

planningUnitId that you want a procurement agent PlanningUnits list for

procurementAgentId
required
integer <int32>

procurementAgentId that you want a procurement agent PlanningUnits list for

term
required
string

term that you want a procurement agent PlanningUnits list for

Responses

Get active PlanningUnit list for a TracerCategory and a Program

API used to get the list of active PlanningUnits for a tracerCategory and a program

Request Body schema: application/json
required

object containing array of tracerCategory and program that you want the PlanningUnit List for

tracerCategoryIds
Array of strings
programIds
Array of strings
programIdsString
string
tracerCategoryIdsString
string

Responses

Request samples

Content type
application/json
{
  • "tracerCategoryIds": [
    ],
  • "programIds": [
    ],
  • "programIdsString": "string",
  • "tracerCategoryIdsString": "string"
}

Get active PlanningUnit list for a realm country

API used to get the list of active PlanningUnits for a realm country

path Parameters
realmCountryId
required
integer <int32>

realmCountryId that you want the PlanningUnit List for

Responses

Get the list of PlanningUnits for a tracerCategoryId

API used to get the list of PlanningUnits for a tracerCategoryId

path Parameters
tracerCategoryId
required
integer <int32>

tracerCategoryId that you want the PlanningUnit List for

Responses

Get the list of PlanningUnits for multiple tracerCategoryIds

API used to get the list of PlanningUnits for multiple tracerCategoryIds

Request Body schema: application/json
required

Array of tracerCategoryIds that you want the PlanningUnit List for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get the list of PlanningUnits for productCategoryId and programId

API used to get the list of PlanningUnits for productCategoryId and programId

path Parameters
productCategoryId
required
integer <int32>

productCategoryId that you want a PlanningUnits list for

programId
required
integer <int32>

programId that you want a PlanningUnits list for

Responses

problem

Get active Problem list for a realm country

API used to get the list of active problem list for a realm

path Parameters
realmId
required
integer <int32>

realmId that you want the problem list for

Responses

Get active Problem Report list for a program and version

API used to get the list of active problem report list for a programId and versionId

path Parameters
programId
required
integer <int32>

programId that you want the problem report list for

versionId
required
integer <int32>

versionId that you want the problem report list for

Responses

Get Problem Status list

API used to get the complete list of problem status

Responses

ProcurementAgentType

Get Complete ProcurementAgentType list

API used to get the complete list of ProcurementAgentType.

Responses

Add ProcurementAgentType

API used to add a ProcurementAgentType

Request Body schema: application/json
required

The procurementAgentType object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementAgentTypeId
integer <int32>
object (SimpleCodeObject)
object (Label)
procurementAgentTypeCode
string
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "procurementAgentTypeId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "procurementAgentTypeCode": "string",
  • "baseModel": {
    }
}

procurementAgentType

Update procurementAgentType

API used to update a procurementAgentType

Request Body schema: application/json
required

The procurementAgentType object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementAgentTypeId
integer <int32>
object (SimpleCodeObject)
object (Label)
procurementAgentTypeCode
string
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "procurementAgentTypeId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "procurementAgentTypeCode": "string",
  • "baseModel": {
    }
}

Get procurementAgentType for a procurementAgentTypeId

API used to get the procurementAgentType for a specific procurementAgentTypeId

path Parameters
procurementAgentTypeId
required
integer <int32>

procurementAgentTypeId that you want to the procurementAgentType for

Responses

Get procurementAgentType list for Realm

API used to get the procurementAgentType list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want to the procurementAgentType for

Responses

procurementAgent

Get Complete ProcurementAgent list

API used to get the complete list of ProcurementAgent.

Responses

Update ProcurementAgent

API used to update a ProcurementAgent

Request Body schema: application/json
required

The ProcurementAgent object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementAgentId
integer <int32>
object (SimpleCodeObject)
object (SimpleCodeObject)
object (Label)
procurementAgentCode
string
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
colorHtmlCode
string
Array of objects (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "procurementAgentId": 0,
  • "realm": {
    },
  • "procurementAgentType": {
    },
  • "label": {
    },
  • "procurementAgentCode": "string",
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "colorHtmlCode": "string",
  • "programList": [
    ],
  • "baseModel": {
    }
}

Add ProcurementAgent

API used to add a ProcurementAgent

Request Body schema: application/json
required

The ProcurementAgent object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementAgentId
integer <int32>
object (SimpleCodeObject)
object (SimpleCodeObject)
object (Label)
procurementAgentCode
string
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
colorHtmlCode
string
Array of objects (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "procurementAgentId": 0,
  • "realm": {
    },
  • "procurementAgentType": {
    },
  • "label": {
    },
  • "procurementAgentCode": "string",
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "colorHtmlCode": "string",
  • "programList": [
    ],
  • "baseModel": {
    }
}

Get ProcurementAgent Planning Unit list for a Procurement Agent

API used to get the ProcurementAgent Planning Unit list for a Procurement Agent. Will only return those PlanningUnits that are marked active.

path Parameters
procurementAgentId
required
integer <int32>

ProcurementAgentId that you want to the ProcurementAgent PlanningUnit list for

Responses

Get ProcurementAgent Procurement Unit list for a Procurement Agent.

API used to get the ProcurementAgent ProcurementUnit list for a Procurement Agent. Will only return those ProcurementUnits that are marked active.

path Parameters
procurementAgentId
required
integer <int32>

ProcurementAgentId that you want to the Procurement Unit list for

Responses

Get ProcurementAgent Planning Unit list for a multiple planningUnitIds

API used to get the ProcurementAgent Planning Unit list for multiple planningUnitIds.

Request Body schema: application/json
required

planningUnitIds that you want to the ProcurementAgent PlanningUnit list for

Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Get ProcurementAgent for a ProcurementAgentId

API used to get the ProcurementAgent for a specific ProcurementAgentId

path Parameters
procurementAgentId
required
integer <int32>

ProcurementAgentId that you want to the ProcurementAgent for

Responses

Get ProcurementAgent by display name

API used to get the ProcurementAgent by providing the display name of the ProcurementAgent and the Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want to the ProcurementAgent for

name
required
string

Display name that you want to the ProcurementAgent for

Responses

Get ProcurementAgent list for Realm

API used to get the ProcurementAgent list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want to the ProcurementAgent for

Responses

Update ProcurementAgent PlanningUnits

API used to save the ProcurementAgentPlanningUnits list

Request Body schema: application/json
required

Array of ProcurementAgentPlanningUnits that you want to save

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementAgentPlanningUnitId
integer <int32>
object (SimpleCodeObject)
object (SimpleObject)
skuCode
string
catalogPrice
number <double>
moq
integer <int32>
unitsPerPalletEuro1
integer <int32>
unitsPerPalletEuro2
integer <int32>
unitsPerContainer
integer <int32>
volume
number <double>
weight
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Complete ProcurementAgent Planning Unit list for a Procurement Agent

API used to get the complete ProcurementAgent Planning Unit list for a Procurement Agent.

path Parameters
procurementAgentId
required
integer <int32>

ProcurementAgentId that you want to the PlanningUnit list for

Responses

Update ProcurementAgent ProcurementUnits

API used to save the ProcurementAgentProcurementUnits list

Request Body schema: application/json
required

Array of ProcurementAgentProcurementUnits that you want to save

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementAgentProcurementUnitId
integer <int32>
object (SimpleObject)
object (SimpleObject)
skuCode
string
vendorPrice
number <double>
approvedToShippedLeadTime
number <double>
gtin
string
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Complete ProcurementAgent Procurement Unit list for a Procurement Agent

API used to get the complete ProcurementAgent ProcurementUnit list for a Procurement Agent.

path Parameters
procurementAgentId
required
integer <int32>

ProcurementAgentId that you want to the Procurement unit list for

Responses

procurementUnit

Get active ProcurementUnit list

API used to get the complete ProcurementUnit list. Will only return those ProcurementUnits that are marked Active.

Responses

Update ProcurementUnit

API used to update a ProcurementUnit

Request Body schema: application/json
required

The ProcurementUnit object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementUnitId
integer <int32>
object (PlanningUnit)
object (Label)
object (SimpleObject)
multiplier
number <double>
object (SimpleObject)
widthQty
number <double>
heightQty
number <double>
lengthQty
number <double>
object (SimpleObject)
weightQty
number <double>
object (SimpleObject)
volumeQty
number <double>
object (SimpleObject)
unitsPerCase
number <double>
unitsPerPalletEuro1
number <double>
unitsPerPalletEuro2
number <double>
unitsPerContainer
number <double>
labeling
string
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "procurementUnitId": 0,
  • "planningUnit": {
    },
  • "label": {
    },
  • "unit": {
    },
  • "multiplier": 0.1,
  • "supplier": {
    },
  • "widthQty": 0.1,
  • "heightQty": 0.1,
  • "lengthQty": 0.1,
  • "lengthUnit": {
    },
  • "weightQty": 0.1,
  • "weightUnit": {
    },
  • "volumeQty": 0.1,
  • "volumeUnit": {
    },
  • "unitsPerCase": 0.1,
  • "unitsPerPalletEuro1": 0.1,
  • "unitsPerPalletEuro2": 0.1,
  • "unitsPerContainer": 0.1,
  • "labeling": "string",
  • "baseModel": {
    }
}

Add ProcurementUnit

API used to add a ProcurementUnit

Request Body schema: application/json
required

The ProcurementUnit object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
procurementUnitId
integer <int32>
object (PlanningUnit)
object (Label)
object (SimpleObject)
multiplier
number <double>
object (SimpleObject)
widthQty
number <double>
heightQty
number <double>
lengthQty
number <double>
object (SimpleObject)
weightQty
number <double>
object (SimpleObject)
volumeQty
number <double>
object (SimpleObject)
unitsPerCase
number <double>
unitsPerPalletEuro1
number <double>
unitsPerPalletEuro2
number <double>
unitsPerContainer
number <double>
labeling
string
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "procurementUnitId": 0,
  • "planningUnit": {
    },
  • "label": {
    },
  • "unit": {
    },
  • "multiplier": 0.1,
  • "supplier": {
    },
  • "widthQty": 0.1,
  • "heightQty": 0.1,
  • "lengthQty": 0.1,
  • "lengthUnit": {
    },
  • "weightQty": 0.1,
  • "weightUnit": {
    },
  • "volumeQty": 0.1,
  • "volumeUnit": {
    },
  • "unitsPerCase": 0.1,
  • "unitsPerPalletEuro1": 0.1,
  • "unitsPerPalletEuro2": 0.1,
  • "unitsPerContainer": 0.1,
  • "labeling": "string",
  • "baseModel": {
    }
}

Get ProcurementUnit for a ProcurementUnitId

API used to get the ProcurementUnit for a specific ProcurementUnitId

path Parameters
procurementUnitId
required
integer <int32>

ProcurementUnitId that you want to the ProcurementUnit for

Responses

Get ProcurementUnit list

API used to get the complete ProcurementUnit list.

Responses

Get ProcurementUnit for a RealmId

API used to get all the ProcurementUnits for a specific RealmId. Will only return those ProcurementUnits that are marked active

path Parameters
realmId
required
integer <int32>

RealmId that you want to the ProcurementUnit for

Responses

Get ProcurementUnit for a RealmId

API used to get all the ProcurementUnits for a specific RealmId.

path Parameters
realmId
required
integer <int32>

RealmId that you want to the ProcurementUnit for

Responses

Get ProcurementUnit for a PlanningUnitId

API used to get all the ProcurementUnits for a specific PlanningUnitId. Will only return those ProcurementUnits that are marked active

path Parameters
planningUnitId
required
integer <int32>

PlanningUnitId that you want to the ProcurementUnit for

Responses

Get ProcurementUnit for a PlanningUnitId

API used to get all the ProcurementUnits for a specific PlanningUnitId.

path Parameters
planningUnitId
required
integer <int32>

PlanningUnitId that you want to the ProcurementUnit for

Responses

productCategory

Get ProductCategory list for Realm

API used to get the complete ProductCategory list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the ProductCategory list for

Responses

Update ProductCategory tree

API used to update the ProductCategory tree

Request Body schema: application/json
required

The Array of ProductCategories that you want to update

Array
id
integer <int32>
parentId
integer <int32>
payload
object
level
integer <int32>
sortOrder
string
payloadId
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get ProductCategory list for Realm

API used to get the complete ProductCategory list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the ProductCategory list for

productCategoryId
required
integer <int32>

ProductCategoryId that you want the Tree for

includeCurrentLevel
required
boolean

true indicates that you want to include the current node of the tree in the output, false will skip the current level and give all the child nodes

includeAllChildren
required
boolean

true will include all the child nodes in the tree in the response, false will only include the immediate child nodes

Responses

Get ProductCategory list for Realm and Program

API used to get the complete ProductCategory list for a Realm and Program

path Parameters
realmId
required
integer <int32>

RealmId that you want the ProductCategory list for

programId
required
integer <int32>

ProgramId that you want the ProductCategory list for

Responses

programData

Get ProgramData for a ProgramId and VersionId

API used to get ProgramData for ProgramId and VersionId

path Parameters
programId
required
integer <int32>

programId that you want to the ProgramData for

versionId
required
integer <int32>

versionId that you want to the ProgramData for

Responses

Get the complete list of VersionType

API used to get the complete list of VersionType

Responses

Get the complete list of VersionStatus

API used to get the complete list of VersionStatus

Responses

Get the last modified date for a program

API to get the last modified date for a program and versionId

path Parameters
programId
required
integer <int32>

programId that you want the last modified date for

versionId
required
integer <int32>

versionId that you want the last modified date for

Responses

Forecasting Unit import data from Supply Plan

API Used in Forecasting Unit import data from Supply Plan

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
planningUnitIds
Array of strings
startDate
string <date-time>
stopDate
string <date-time>
regionIds
Array of strings
planningUnitIdString
string
regionIdString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "planningUnitIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "regionIds": [
    ],
  • "planningUnitIdString": "string",
  • "regionIdString": "string"
}

Get the list of programVersion based on given parameters and date range

API used to get the list of programVersion based on given parameters and date range

path Parameters
programId
required
integer <int32>

programId that you want to the programVersion list for

versionId
required
integer <int32>

versionId that you want to the programVersion list for

realmCountryId
required
integer <int32>

realmCountryId that you want to the programVersion list for

healthAreaId
required
integer <int32>

healthAreaId that you want to the programVersion list for

organisationId
required
integer <int32>

organisationId that you want to the programVersion list for

versionTypeId
required
integer <int32>

versionTypeId that you want to the programVersion list for

versionStatusId
required
integer <int32>

versionStatusId that you want to the programVersion list for

startDate
required
string

startDate that you want to the programVersion list from

stopDate
required
string

stopDate that you want to the programVersion list till

Responses

Update a programVersion for given programId and versionId

API used to update a programVersion for given programId and versionId

path Parameters
programId
required
integer <int32>

programId that you want to update programVersion for

versionId
required
integer <int32>

versionId that you want to update programVersion for

versionStatusId
required
integer <int32>

versionStatusId that you want to update in programVersion

Request Body schema: application/json
required

updateProgramVersion object that you want to update

Array of objects (ReviewedProblem)
notes
string

Responses

Request samples

Content type
application/json
{
  • "reviewedProblemList": [
    ],
  • "notes": "string"
}

Check ERP order status

API to check ERP order status

path Parameters
orderNo
required
string
primeLineNo
required
string
realmCountryId
required
integer <int32>
planningUnitId
required
integer <int32>

Responses

Get ProgramData list for listed ProgramIds and VersionIds

API used to get ProgramData list for listed ProgramIds and VersionIds

Request Body schema: application/json
required

programVersionList list of ProgramIds and VersionIds that you want a ProgramData list for

Array
programId
integer <int32>
versionId
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Artmis view ProgramData list for given ProgramId and VersionId

API used to get Artmis view ProgramData list for given ProgramId and VersionId

path Parameters
programId
required
integer <int32>

programId that you want to the ProgramData for

versionId
required
integer <int32>

versionId that you want to the ProgramData for

Responses

Get Artmis view ProgramData list for given ProgramId and VersionId

API used to get GfpVan view ProgramData list for given ProgramId and VersionId

path Parameters
programId
required
integer <int32>

programId that you want to the ProgramData for

versionId
required
integer <int32>

versionId that you want to the ProgramData for

Responses

Get list of Shipment data for given programId and versionId which are modified after given date

API used to get list of Shipment data for given programId and versionId which are modified after given date

path Parameters
programId
required
integer <int32>

programId that want the Shipment data for

versionId
required
integer <int32>

versionId that want the Shipment data for

userId
required
integer <int32>

userId need this back in response

lastSyncDate
required
string

lastSyncDate that you want a Shipment data list

Responses

To check if newer version available for list programIds and versionIds

API to check if newer version available for list programIds and versionIds

Request Body schema: application/json
required

programVersionList that you want to check newer version for

Array
programId
integer <int32>
versionId
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get the latest version for a program

API to get the latest version for a program

path Parameters
programId
required
integer <int32>

programId that you want the latest version for

Responses

Get latest version for given programs

API Used to get latest version for given programIds

Request Body schema: application/json
required

programIds that you want latest version for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

program

Get Program list for Program Ids

API used to get the Program list for a list of Program Ids

Request Body schema: application/json
required

Array of ProgramIds that you want to the list of Programs

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get Active Program list

API used to get the active Program list

Responses

Update Program

API used to update a Program

Request Body schema: application/json
required

Program object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programId
integer <int32>
programCode
string
object (RealmCountry)
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BasicUser)
programNotes
string
airFreightPerc
number <double>
seaFreightPerc
number <double>
plannedToSubmittedLeadTime
number <double>
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
shippedToArrivedByAirLeadTime
number <double>
shippedToArrivedBySeaLeadTime
number <double>
arrivedToDeliveredLeadTime
number <double>
programTypeId
integer <int32>
Array of objects (Region)
object (Version)
Array of objects (Version)
healthAreaArray
Array of strings
regionArray
Array of strings
healthAreaIdList
Array of integers <int32> [ items <int32 > ]
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "programId": 0,
  • "programCode": "string",
  • "realmCountry": {
    },
  • "organisation": {
    },
  • "healthAreaList": [
    ],
  • "label": {
    },
  • "programManager": {
    },
  • "programNotes": "string",
  • "airFreightPerc": 0.1,
  • "seaFreightPerc": 0.1,
  • "plannedToSubmittedLeadTime": 0.1,
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "shippedToArrivedByAirLeadTime": 0.1,
  • "shippedToArrivedBySeaLeadTime": 0.1,
  • "arrivedToDeliveredLeadTime": 0.1,
  • "programTypeId": 0,
  • "regionList": [
    ],
  • "currentVersion": {
    },
  • "versionList": [
    ],
  • "healthAreaArray": [
    ],
  • "regionArray": [
    ],
  • "healthAreaIdList": [
    ],
  • "baseModel": {
    }
}

Add Program

API used to add a Program

Request Body schema: application/json
required

Program object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programId
integer <int32>
programCode
string
object (RealmCountry)
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BasicUser)
programNotes
string
airFreightPerc
number <double>
seaFreightPerc
number <double>
plannedToSubmittedLeadTime
number <double>
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
shippedToArrivedByAirLeadTime
number <double>
shippedToArrivedBySeaLeadTime
number <double>
arrivedToDeliveredLeadTime
number <double>
programTypeId
integer <int32>
Array of objects (Region)
object (Version)
Array of objects (Version)
healthAreaArray
Array of strings
regionArray
Array of strings
healthAreaIdList
Array of integers <int32> [ items <int32 > ]
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "programId": 0,
  • "programCode": "string",
  • "realmCountry": {
    },
  • "organisation": {
    },
  • "healthAreaList": [
    ],
  • "label": {
    },
  • "programManager": {
    },
  • "programNotes": "string",
  • "airFreightPerc": 0.1,
  • "seaFreightPerc": 0.1,
  • "plannedToSubmittedLeadTime": 0.1,
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "shippedToArrivedByAirLeadTime": 0.1,
  • "shippedToArrivedBySeaLeadTime": 0.1,
  • "arrivedToDeliveredLeadTime": 0.1,
  • "programTypeId": 0,
  • "regionList": [
    ],
  • "currentVersion": {
    },
  • "versionList": [
    ],
  • "healthAreaArray": [
    ],
  • "regionArray": [
    ],
  • "healthAreaIdList": [
    ],
  • "baseModel": {
    }
}

Get Program Object For Specified ProgramId

API used to get the Program object for specified programId

path Parameters
programId
required
integer <int32>

programId that you want to get Program object for

Responses

List five versions of program from give page number for specified programId

API used to list five versions of program from given page number for specified programId

path Parameters
programId
required
integer <int32>

programId that you want to get program list for

page
required
integer <int32>

number that you want to get program list from

Responses

Load Program

API used to load program.

Responses

Validate Program for specified realmId,programId and programCode

API used to validate Program for specified realmId,programId and programCode

path Parameters
realmId
required
integer <int32>

realmId that you want to validate program for

programId
required
integer <int32>

programId that you want to validate program for

programCode
required
string

programCode that you want to validate program for

Responses

Save a PlanningUnit Unit For Specified Program

API used to save a PlanningUnit Unit for specified programId

Request Body schema: application/json
required

Array of ProgramPlanningUnit object that you want to save

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programPlanningUnitId
integer <int32>
object (SimpleObject)
object (SimpleObject)
object (SimpleObject)
object (SimpleObject)
multiplier
number <double>
reorderFrequencyInMonths
integer <int32>
minMonthsOfStock
integer <int32>
localProcurementLeadTime
number <double>
shelfLife
integer <int32>
catalogPrice
number <double>
monthsInFutureForAmc
integer <int32>
monthsInPastForAmc
integer <int32>
Array of objects (ProgramPlanningUnitProcurementAgentPrice)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Complete Program list

API used to get the complete Program list

Responses

Get Planning Unit List For Specified ProgramId

API used to get the Planning unit list for specified programId

path Parameters
programId
required
integer <int32>

programId that you want to get Planning unit list for

Responses

Get Planning Unit List For Specified ProgramId and TracerCategoryIds

API used to get the Planning unit list for specified programId and tracerCategoryIds

path Parameters
programId
required
integer <int32>

programId that you want to get Planning unit list for

Request Body schema: application/json
required

Array of tracerCategoryIds that you want to get Planning unit list for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get simple Planning Unit List For Specified ProgramId and TracerCategoryIds

API used to get simple Planning unit list for specified programId and tracerCategoryIds

path Parameters
programId
required
integer <int32>

programId that you want to get simple Planning unit list for

Request Body schema: application/json
required

Array of tracerCategoryIds that you want to get simple Planning unit list for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get Complete Planning Unit List For Specified ProgramId

API used to get the complete Planning unit list for specified programId

path Parameters
programId
required
integer <int32>

programId that you want to get Planning unit list for

Responses

Get ProcurementAgent List For Specified ProgramPlanningUnitId

API used to get the ProcurementAgent list for specified ProgramPlanningUnitId

path Parameters
programPlanningUnitId
required
integer <int32>

ProgramPlanningUnitId that you want to get ProcurementAgent list for

Responses

Save PlanningUnit Unit, ProcurementAgent and Price

API used to save a PlanningUnit Unit, ProcurementAgent and Price

Request Body schema: application/json
required

Array of programPlanningUnitProcurementAgentPrices object that you want to save

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programPlanningUnitProcurementAgentId
integer <int32>
programPlanningUnitId
integer <int32>
object (SimpleCodeObject)
object (SimpleObject)
object (SimpleObject)
price
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

get PlanningUnit List For Specified ProgramIds

API used to get the PlanningUnit list for specified ProgramIds

Request Body schema: application/json
required

Array of programIds that you want to get PlanningUnit list for

Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Get Program List For Specified Realm

API used to get the Program list for specified realm

path Parameters
realmId
required
integer <int32>

realmId that you want to get Program list for

Responses

Get Planning Unit List For Specified ProgramId and ProductCategoryId

API used to get the Planning unit list for specified programId and ProductCategoryId

path Parameters
programId
required
integer <int32>

programId that you want to get Planning unit list for

productCategoryId
required
integer <int32>

productCategoryId that you want to get Planning unit list for

Responses

Add a ProgramInitialize

API used to add a ProgramInitialize

Request Body schema: application/json
required

ProgramInitialize object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
programId
integer <int32>
programCode
string
object (RealmCountry)
object (SimpleCodeObject)
Array of objects (SimpleCodeObject)
object (Label)
object (BasicUser)
programNotes
string
airFreightPerc
number <double>
seaFreightPerc
number <double>
plannedToSubmittedLeadTime
number <double>
submittedToApprovedLeadTime
number <double>
approvedToShippedLeadTime
number <double>
shippedToArrivedByAirLeadTime
number <double>
shippedToArrivedBySeaLeadTime
number <double>
arrivedToDeliveredLeadTime
number <double>
programTypeId
integer <int32>
Array of objects (Region)
object (Version)
Array of objects (Version)
Array of objects (ProgramPlanningUnit)
healthAreaArray
Array of strings
regionArray
Array of strings
healthAreaIdList
Array of integers <int32> [ items <int32 > ]
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "programId": 0,
  • "programCode": "string",
  • "realmCountry": {
    },
  • "organisation": {
    },
  • "healthAreaList": [
    ],
  • "label": {
    },
  • "programManager": {
    },
  • "programNotes": "string",
  • "airFreightPerc": 0.1,
  • "seaFreightPerc": 0.1,
  • "plannedToSubmittedLeadTime": 0.1,
  • "submittedToApprovedLeadTime": 0.1,
  • "approvedToShippedLeadTime": 0.1,
  • "shippedToArrivedByAirLeadTime": 0.1,
  • "shippedToArrivedBySeaLeadTime": 0.1,
  • "arrivedToDeliveredLeadTime": 0.1,
  • "programTypeId": 0,
  • "regionList": [
    ],
  • "currentVersion": {
    },
  • "versionList": [
    ],
  • "programPlanningUnits": [
    ],
  • "healthAreaArray": [
    ],
  • "regionArray": [
    ],
  • "healthAreaIdList": [
    ],
  • "baseModel": {
    }
}

Get supply plan reviewer list for specified program

API used to get supply plan reviewer list for specified program

path Parameters
programId
required
integer <int32>

programId that you want to supply plan reviewer list for

Responses

quantimed

Format forecast data to import

API used to format forecast data to import in a specified program

path Parameters
programId
required
string

ProgramId that you want to format forecast data to import for

Request Body schema: application/json

File containing forecast data to format for import

file
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

realmCountry

Get RealmCountry for a specific RealmCountryId

API used to get the RealmCountry for a specific RealmCountryId

path Parameters
realmCountryId
required
integer <int32>

RealmCountryId that you want RealmCountry for

Responses

Get active RealmCountry list

API used to get the complete RealmCountry list. Will only return those RealmCountries that are marked Active.

Responses

Update RealmCountry

API used to update a RealmCountry

Request Body schema: application/json
required

List of RealmCountry that you want to update

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
realmCountryId
integer <int32>
object (Country)
object (Realm)
object (Currency)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Add RealmCountry

API used to add a RealmCountry

Request Body schema: application/json
required

List of RealmCountry that you want to add

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
realmCountryId
integer <int32>
object (Country)
object (Realm)
object (Currency)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Save PlanningUnit for RealmCountry

API used to save PlanningUnit for RealmCountry

Request Body schema: application/json
required

Array of realmCountryPlanningUnits that you want to save

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
realmCountryPlanningUnitId
integer <int32>
object (SimpleObject)
object (SimpleObject)
skuCode
string
object (Label)
multiplier
number <double>
object (Unit)
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get RealmCountryPlanningUnit list for a specific programIds

API used to get RealmCountryPlanningUnit list for a specific programIds

Request Body schema: application/json
required

Array of programIds that you want RealmCountryPlanningUnit list for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get RealmCountry list for a specific realmId

API used to get the RealmCountry list for a specific realmId

path Parameters
realmId
required
integer <int32>

RealmId that you want RealmCountry list for

Responses

Get PlanningUnit list for a specific realmCountryId

API used to get the active PlanningUnit list for a specific realmCountryId

path Parameters
realmCountryId
required
integer <int32>

RealmCountryId that you want PlanningUnit list for

Responses

Get Complete PlanningUnit list for a specific realmCountryId

API used to get the complete PlanningUnit list for a specific realmCountryId

path Parameters
realmCountryId
required
integer <int32>

RealmCountryId that you want PlanningUnit list for

Responses

Get RealmCountry list by specified reamId for active programs

API used to get the RealmCountry list by specified reamId for active programs

path Parameters
realmId
required
integer <int32>

RealmId that you want RealmCountry list for

Responses

Get the RealmCountry list active programs

API used to get the RealmCountry list active programs

Responses

realm

Get Realm list

API used to get the complete Realm list.

Responses

Update Realm

API used to update a Realm

Request Body schema: application/json
required

The Realm object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
realmId
integer <int32>
object (Label)
realmCode
string
defaultRealm
boolean
minMosMinGaurdrail
integer <int32>
minMosMaxGaurdrail
integer <int32>
maxMosMaxGaurdrail
integer <int32>
minQplTolerance
integer <int32>
minQplToleranceCutOff
integer <int32>
maxQplTolerance
integer <int32>
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "realmId": 0,
  • "label": {
    },
  • "realmCode": "string",
  • "defaultRealm": true,
  • "minMosMinGaurdrail": 0,
  • "minMosMaxGaurdrail": 0,
  • "maxMosMaxGaurdrail": 0,
  • "minQplTolerance": 0,
  • "minQplToleranceCutOff": 0,
  • "maxQplTolerance": 0,
  • "baseModel": {
    }
}

Add Realm

API used to add a Realm

Request Body schema: application/json
required

The Realm object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
realmId
integer <int32>
object (Label)
realmCode
string
defaultRealm
boolean
minMosMinGaurdrail
integer <int32>
minMosMaxGaurdrail
integer <int32>
maxMosMaxGaurdrail
integer <int32>
minQplTolerance
integer <int32>
minQplToleranceCutOff
integer <int32>
maxQplTolerance
integer <int32>
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "realmId": 0,
  • "label": {
    },
  • "realmCode": "string",
  • "defaultRealm": true,
  • "minMosMinGaurdrail": 0,
  • "minMosMaxGaurdrail": 0,
  • "maxMosMaxGaurdrail": 0,
  • "minQplTolerance": 0,
  • "minQplToleranceCutOff": 0,
  • "maxQplTolerance": 0,
  • "baseModel": {
    }
}

Get Realm for a RealmId

API used to get the Realm for a specific RealmId

path Parameters
realmId
required
integer <int32>

RealmId that you want to the Realm for

Responses

region

Get Region list

API used to get the complete Region list.

Responses

Update Region

API used to update a Region

Request Body schema: application/json
required

The array of Regions that you want to update

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
regionId
integer <int32>
object (Label)
object (RealmCountry)
gln
string
capacityCbm
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Region for a RegionId

API used to get the Region for a specific RegionId

path Parameters
regionId
required
integer <int32>

RegionId that you want to the Region for

Responses

Get Region list based on RealmCountry list

API used to get the Region list for a list of RealmCountry Ids. Empty list means you want the complete list of Regions

path Parameters
realmCountryId
required
integer <int32>

RealmCountryId that you want the Region list for

Responses

report

get the ExpiredStockOutput list

API used to get the ExpiredStockOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
includePlannedShipments
boolean

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "includePlannedShipments": true
}

get the CostOfInventoryOutput list

API used to get the CostOfInventoryOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
dt
string <date-time>
includePlannedShipments
boolean

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "dt": "2019-08-24T14:15:22Z",
  • "includePlannedShipments": true
}

get the InventoryTurnsOutput list

API used to get the InventoryTurnsOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
dt
string <date-time>
includePlannedShipments
boolean

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "dt": "2019-08-24T14:15:22Z",
  • "includePlannedShipments": true
}

get the StockAdjustmentReportOutput list

API used to get the StockAdjustmentReportOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
planningUnitIds
Array of strings
startDateString
string
stopDateString
string
planningUnitIdString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "planningUnitIds": [
    ],
  • "startDateString": "string",
  • "stopDateString": "string",
  • "planningUnitIdString": "string"
}

get the ProcurementAgentShipmentReportOutput list

API used to get the ProcurementAgentShipmentReportOutput list.

Request Body schema: application/json
required
startDate
string <date-time>
stopDate
string <date-time>
programId
integer <int32>
versionId
integer <int32>
planningUnitIds
Array of strings
includePlannedShipments
boolean
procurementAgentIds
Array of strings
procurementAgentIdString
string
planningUnitIdString
string

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "programId": 0,
  • "versionId": 0,
  • "planningUnitIds": [
    ],
  • "includePlannedShipments": true,
  • "procurementAgentIds": [
    ],
  • "procurementAgentIdString": "string",
  • "planningUnitIdString": "string"
}

get the ProgramLeadTimesOutput list

API used to get the ProgramLeadTimesOutput list.

Request Body schema: application/json
required
programId
integer <int32>
planningUnitIds
Array of strings
procurementAgentIds
Array of strings
planningUnitIdString
string
procurementAgentIdString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "planningUnitIds": [
    ],
  • "procurementAgentIds": [
    ],
  • "planningUnitIdString": "string",
  • "procurementAgentIdString": "string"
}

get the FundingSourceShipmentReportOutput list

API used to get the FundingSourceShipmentReportOutput list.

Request Body schema: application/json
required
startDate
string <date-time>
stopDate
string <date-time>
programId
integer <int32>
versionId
integer <int32>
planningUnitIds
Array of strings
includePlannedShipments
boolean
fundingSourceIds
Array of strings
fundingSourceIdString
string
planningUnitIdString
string

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "programId": 0,
  • "versionId": 0,
  • "planningUnitIds": [
    ],
  • "includePlannedShipments": true,
  • "fundingSourceIds": [
    ],
  • "fundingSourceIdString": "string",
  • "planningUnitIdString": "string"
}

get the StockStatusVerticalOutput list

API used to get the StockStatusVerticalOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
planningUnitId
integer <int32>
allPlanningUnits
boolean

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "planningUnitId": 0,
  • "allPlanningUnits": true
}

get the StockStatusOverTimeOutput list

API used to get the StockStatusOverTimeOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
mosPast
integer <int32>
mosFuture
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
planningUnitIds
Array of strings
planningUnitIdString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "mosPast": 0,
  • "mosFuture": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "planningUnitIds": [
    ],
  • "planningUnitIdString": "string"
}

get the ProgramProductCatalogOutput list

API used to get the ProgramProductCatalogOutput list.

Request Body schema: application/json
required
programId
integer <int32>
productCategoryId
integer <int32>
tracerCategoryId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "productCategoryId": 0,
  • "tracerCategoryId": 0
}

get the ConsumptionForecastVsActualOutput list

API used to get the ConsumptionForecastVsActualOutput list.

Request Body schema: application/json
required
startDate
string <date-time>
stopDate
string <date-time>
programId
integer <int32>
versionId
integer <int32>
planningUnitId
integer <int32>
reportView
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "programId": 0,
  • "versionId": 0,
  • "planningUnitId": 0,
  • "reportView": 0
}

get the GlobalConsumptionOutput list

API used to get the GlobalConsumptionOutput list.

Request Body schema: application/json
required
realmId
integer <int32>
realmCountryIds
Array of strings
programIds
Array of strings
planningUnitIds
Array of strings
startDate
string <date-time>
stopDate
string <date-time>
reportView
integer <int32>
useApprovedSupplyPlanOnly
boolean
planningUnitIdString
string
programIdString
string
realmCountryIdString
string

Responses

Request samples

Content type
application/json
{
  • "realmId": 0,
  • "realmCountryIds": [
    ],
  • "programIds": [
    ],
  • "planningUnitIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "reportView": 0,
  • "useApprovedSupplyPlanOnly": true,
  • "planningUnitIdString": "string",
  • "programIdString": "string",
  • "realmCountryIdString": "string"
}

get the ForecastMetricsMonthlyOutput list

API used to get the ForecastMetricsMonthlyOutput list.

Request Body schema: application/json
required
startDate
string <date-time>
stopDate
string <date-time>
programId
integer <int32>
versionId
integer <int32>
planningUnitId
integer <int32>
previousMonths
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "programId": 0,
  • "versionId": 0,
  • "planningUnitId": 0,
  • "previousMonths": 0
}

get the ForecastMetricsComparisionOutput list

API used to get the ForecastMetricsComparisionOutput list.

Request Body schema: application/json
required
realmId
integer <int32>
realmCountryIds
Array of strings
programIds
Array of strings
planningUnitIds
Array of strings
tracerCategoryIds
Array of strings
startDate
string <date-time>
previousMonths
integer <int32>
useApprovedSupplyPlanOnly
boolean

Responses

Request samples

Content type
application/json
{
  • "realmId": 0,
  • "realmCountryIds": [
    ],
  • "programIds": [
    ],
  • "planningUnitIds": [
    ],
  • "tracerCategoryIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "previousMonths": 0,
  • "useApprovedSupplyPlanOnly": true
}

get the StockStatusMatrixOutput list

API used to get the StockStatusMatrixOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
planningUnitIds
Array of strings
tracerCategoryIds
Array of strings
includePlannedShipments
boolean

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "planningUnitIds": [
    ],
  • "tracerCategoryIds": [
    ],
  • "includePlannedShipments": true
}

get the ShipmentDetailsOutput object

API used to get the ShipmentDetailsOutput object.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
fundingSourceIds
Array of strings
budgetIds
Array of strings
planningUnitIds
Array of strings
reportView
integer <int32>
planningUnitIdsString
string
fundingSourceIdsString
string
budgetIdsString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "fundingSourceIds": [
    ],
  • "budgetIds": [
    ],
  • "planningUnitIds": [
    ],
  • "reportView": 0,
  • "planningUnitIdsString": "string",
  • "fundingSourceIdsString": "string",
  • "budgetIdsString": "string"
}

get the ShipmentOverviewOutput object

API used to get the ShipmentOverviewOutput object.

Request Body schema: application/json
required
realmId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
realmCountryIds
Array of strings
programIds
Array of strings
planningUnitIds
Array of strings
fundingSourceIds
Array of strings
shipmentStatusIds
Array of strings
useApprovedSupplyPlanOnly
boolean
programIdsString
string
planningUnitIdsString
string
fundingSourceIdsString
string
realmCountryIdsString
string
shipmentStatusIdsString
string

Responses

Request samples

Content type
application/json
{
  • "realmId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "realmCountryIds": [
    ],
  • "programIds": [
    ],
  • "planningUnitIds": [
    ],
  • "fundingSourceIds": [
    ],
  • "shipmentStatusIds": [
    ],
  • "useApprovedSupplyPlanOnly": true,
  • "programIdsString": "string",
  • "planningUnitIdsString": "string",
  • "fundingSourceIdsString": "string",
  • "realmCountryIdsString": "string",
  • "shipmentStatusIdsString": "string"
}

get the ShipmentGlobalDemandOutput object

API used to get the ShipmentGlobalDemandOutput object.

Request Body schema: application/json
required
realmId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
realmCountryIds
Array of strings
planningUnitId
integer <int32>
reportView
integer <int32>
fundingSourceProcurementAgentIds
Array of strings
useApprovedSupplyPlanOnly
boolean
includePlannedShipments
boolean
realmCountryIdsString
string
fundingSourceProcurementAgentIdsString
string

Responses

Request samples

Content type
application/json
{
  • "realmId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "realmCountryIds": [
    ],
  • "planningUnitId": 0,
  • "reportView": 0,
  • "fundingSourceProcurementAgentIds": [
    ],
  • "useApprovedSupplyPlanOnly": true,
  • "includePlannedShipments": true,
  • "realmCountryIdsString": "string",
  • "fundingSourceProcurementAgentIdsString": "string"
}

get the AnnualShipmentCostOutput list

API used to get the AnnualShipmentCostOutput list.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
planningUnitIds
Array of strings
procurementAgentIds
Array of strings
fundingSourceIds
Array of strings
shipmentStatusIds
Array of strings
startDate
string <date-time>
stopDate
string <date-time>
reportBasedOn
integer <int32>
planningUnitIdString
string
procurementAgentIdString
string
fundingSourceIdString
string
shipmentStatusIdString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "planningUnitIds": [
    ],
  • "procurementAgentIds": [
    ],
  • "fundingSourceIds": [
    ],
  • "shipmentStatusIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "reportBasedOn": 0,
  • "planningUnitIdString": "string",
  • "procurementAgentIdString": "string",
  • "fundingSourceIdString": "string",
  • "shipmentStatusIdString": "string"
}

get the ShipmentReportOutput list

API used to get the ShipmentReportOutput list.

Request Body schema: application/json
required
startDate
string <date-time>
stopDate
string <date-time>
programId
integer <int32>
versionId
integer <int32>
planningUnitIds
Array of strings
includePlannedShipments
boolean
planningUnitIdString
string

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "programId": 0,
  • "versionId": 0,
  • "planningUnitIds": [
    ],
  • "includePlannedShipments": true,
  • "planningUnitIdString": "string"
}

get the StockStatusForProgramOutput list

API used to get the StockStatusForProgramOutput list.

Request Body schema: application/json
required
dt
string <date-time>
programId
integer <int32>
versionId
integer <int32>
tracerCategoryIds
Array of strings
includePlannedShipments
boolean
tracerCategoryIdString
string

Responses

Request samples

Content type
application/json
{
  • "dt": "2019-08-24T14:15:22Z",
  • "programId": 0,
  • "versionId": 0,
  • "tracerCategoryIds": [
    ],
  • "includePlannedShipments": true,
  • "tracerCategoryIdString": "string"
}

get the BudgetReportOutput list

API used to get the BudgetReportOutput list.

Request Body schema: application/json
required
startDate
string <date-time>
stopDate
string <date-time>
fundingSourceIds
Array of strings
programId
integer <int32>
versionId
integer <int32>
fundingSourceIdString
string

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "fundingSourceIds": [
    ],
  • "programId": 0,
  • "versionId": 0,
  • "fundingSourceIdString": "string"
}

Get Forecast error report

API used to get the forecast error report.

Request Body schema: application/json
required
programId
integer <int32>
versionId
integer <int32>
viewBy
integer <int32>
unitId
integer <int32>
regionIds
Array of strings
startDate
string <date-time>
stopDate
string <date-time>
equivalencyUnitId
integer <int32>
regionIdString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "viewBy": 0,
  • "unitId": 0,
  • "regionIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "equivalencyUnitId": 0,
  • "regionIdString": "string"
}

Get MOnthly Forecast report

API used to get the monthly forecast report.

Request Body schema: application/json
required

MonthlyForecastInput object that you want to monthly forecast report for

programId
integer <int32>
versionId
integer <int32>
startDate
string <date-time>
stopDate
string <date-time>
reportView
integer <int32>
aggregateByYear
boolean
unitIds
Array of strings
unitIdString
string

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": "2019-08-24T14:15:22Z",
  • "reportView": 0,
  • "aggregateByYear": true,
  • "unitIds": [
    ],
  • "unitIdString": "string"
}

Get Forecast summary report

API used to get the forecast summary report.

Request Body schema: application/json
required

ForecastSummaryInput object that you want to forecast summary report for

programId
integer <int32>
versionId
integer <int32>
reportView
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "programId": 0,
  • "versionId": 0,
  • "reportView": 0
}

get the WarehouseCapacityOutput list

API used to get the WarehouseCapacityOutput list.

Request Body schema: application/json
required
realmCountryIds
Array of strings
programIds
Array of strings
programIdString
string
realmCountryIdString
string

Responses

Request samples

Content type
application/json
{
  • "realmCountryIds": [
    ],
  • "programIds": [
    ],
  • "programIdString": "string",
  • "realmCountryIdString": "string"
}

get the WarehouseByCountryOutput list

API used to get the WarehouseByCountryOutput list.

Request Body schema: application/json
required
realmCountryIds
Array of strings
realmCountryIdString
string

Responses

Request samples

Content type
application/json
{
  • "realmCountryIds": [
    ],
  • "realmCountryIdString": "string"
}

get the StockStatusAcrossProductsOutput list

API used to get the StockStatusAcrossProductsOutput list.

Request Body schema: application/json
required
realmId
integer <int32>
dt
string <date-time>
tracerCategoryIds
Array of strings
realmCountryIds
Array of strings
programIds
Array of strings
useApprovedSupplyPlanOnly
boolean
programIdsString
string
tracerCategoryIdsString
string
realmCountryIdsString
string

Responses

Request samples

Content type
application/json
{
  • "realmId": 0,
  • "dt": "2019-08-24T14:15:22Z",
  • "tracerCategoryIds": [
    ],
  • "realmCountryIds": [
    ],
  • "programIds": [
    ],
  • "useApprovedSupplyPlanOnly": true,
  • "programIdsString": "string",
  • "tracerCategoryIdsString": "string",
  • "realmCountryIdsString": "string"
}

shipmentStatus

Get Active ShipmentStatus list.

API used to get the active ShipmentStatus list.

Responses

supplier

Get Supplier for a SupplierId

API used to get the Supplier for a specific SupplierId

path Parameters
supplierId
required
integer <int32>

SupplierId that you want to the Supplier for

Responses

Get Supplier list

API used to get the complete Supplier list.

Responses

Update Supplier

API used to update a Supplier

Request Body schema: application/json
required

The Supplier object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
supplierId
integer <int32>
object (Label)
object (SimpleCodeObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "supplierId": 0,
  • "label": {
    },
  • "realm": {
    },
  • "baseModel": {
    }
}

Add Supplier

API used to add a Supplier

Request Body schema: application/json
required

The Supplier object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
supplierId
integer <int32>
object (Label)
object (SimpleCodeObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "supplierId": 0,
  • "label": {
    },
  • "realm": {
    },
  • "baseModel": {
    }
}

Get Supplier list for Realm

API used to get the complete Supplier list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the Supplier list for

Responses

supplyPlan

To rebuild supply plan based on rebuild true or false

API is to rebuild supply plan based on rebuild true or false

path Parameters
programId
required
integer <int32>

programId that you want to rebuild supply plan for

versionId
required
integer <int32>

versionId that you want to rebuild supply plan for

rebuild
required
boolean

rebuild true for rebuild supply plan , rebuild false for do not rebuild supply plan

Responses

To rebuild supply plan for listed programIds and versionIds

API is to rebuild supply plan for listed programIds and versionIds

Request Body schema: application/json
required

pvList list of programIds and versionIds to rebuild supply plan for

Array
programId
integer <int32>
versionId
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

user

Check for user access to specified programIds

API used to check for user access to specified programIds

Request Body schema: application/json
required

Array of programIds to check access for

Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Check for user access to specified programIds using query

API used to check for user access to specified programIds using query

Request Body schema: application/json
required

Array of programIds to check access for

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Logout

API used to logout

Responses

Get User list

API used to get the User list

Responses

Update User

API used to update a user

Request Body schema: application/json
required

user object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
userId
integer <int32>
username
string
password
string
emailId
string
orgAndCountry
string
object (Realm)
Array of objects (Role)
roles
Array of strings
object (Language)
defaultModuleId
integer <int32>
faildAttempts
integer <int32>
lastLoginDate
string <date-time>
Array of objects (UserAcl)
Array of objects (UserAcl)
businessFunctionList
Array of strings
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "userId": 0,
  • "username": "string",
  • "password": "string",
  • "emailId": "string",
  • "orgAndCountry": "string",
  • "realm": {
    },
  • "roleList": [
    ],
  • "roles": [
    ],
  • "language": {
    },
  • "defaultModuleId": 0,
  • "faildAttempts": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "userAclList": [
    ],
  • "userAcls": [
    ],
  • "businessFunctionList": [
    ],
  • "baseModel": {
    }
}

Add User

API used to add a user

Request Body schema: application/json
required

user object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
userId
integer <int32>
username
string
password
string
emailId
string
orgAndCountry
string
object (Realm)
Array of objects (Role)
roles
Array of strings
object (Language)
defaultModuleId
integer <int32>
faildAttempts
integer <int32>
lastLoginDate
string <date-time>
Array of objects (UserAcl)
Array of objects (UserAcl)
businessFunctionList
Array of strings
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "userId": 0,
  • "username": "string",
  • "password": "string",
  • "emailId": "string",
  • "orgAndCountry": "string",
  • "realm": {
    },
  • "roleList": [
    ],
  • "roles": [
    ],
  • "language": {
    },
  • "defaultModuleId": 0,
  • "faildAttempts": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "userAclList": [
    ],
  • "userAcls": [
    ],
  • "businessFunctionList": [
    ],
  • "baseModel": {
    }
}

Get the User list for specified realmId

API used to get the User list for specified realmId

path Parameters
realmId
required
integer <int32>

RealmId that you want the User list for

Responses

Get user list by programId

API used to get user list by providing programId

path Parameters
programId
required
integer <int32>

programId that you want to the user list for

Responses

Get the User object for specified userId

API used to get the User object for specified userId

path Parameters
userId
required
integer <int32>

Responses

Get BusinessFunction list

API used to get the BusinessFunction list

Responses

Update password

API used to update password

Request Body schema: application/json
required

EmailUser object for which password has to update

userId
integer <int32>
username
string
emailId
string
token
string
password
string
hashPassword
string

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "username": "string",
  • "emailId": "string",
  • "token": "string",
  • "password": "string",
  • "hashPassword": "string"
}

Update user language

API used to update user language

Request Body schema: application/json
required

LanguageUser object that you want language to update

userId
integer <int32>
languageCode
string

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "languageCode": "string"
}

Update a user module

API used to update a user module

path Parameters
moduleId
required
integer <int32>

moduleId that you want to update a user module

Responses

Update user agreement accepted

API used to update user agreement accepted

Responses

Get Role object for a specific roleId

API used to get the Role object for a specific roleId

path Parameters
roleId
required
string

roleId that you want the Role Object for

Responses

Get Role list for current user

API used to get the Role list for current user

Responses

Update Role

API used to update a Role

Request Body schema: application/json
required

role object that you want to update

roleId
string
object (Label)
Array of objects (BusinessFunction)
businessFunctions
Array of strings
Array of objects (CanCreateRole)
canCreateRoles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "roleId": "string",
  • "label": {
    },
  • "businessFunctionList": [
    ],
  • "businessFunctions": [
    ],
  • "canCreateRoleList": [
    ],
  • "canCreateRoles": [
    ]
}

Add Role

API used to add a Role

Request Body schema: application/json
required

role object that you want to add

roleId
string
object (Label)
Array of objects (BusinessFunction)
businessFunctions
Array of strings
Array of objects (CanCreateRole)
canCreateRoles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "roleId": "string",
  • "label": {
    },
  • "businessFunctionList": [
    ],
  • "businessFunctions": [
    ],
  • "canCreateRoleList": [
    ],
  • "canCreateRoles": [
    ]
}

Get userDetails for current user

API used to get the userDetails for current user

Responses

Update Expired Password

API used to update expired password

Request Body schema: application/json
required

password object that you want to update

userId
integer <int32>
emailId
string
oldPassword
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "emailId": "string",
  • "oldPassword": "string",
  • "newPassword": "string"
}

Change password

API used to update changed password

Request Body schema: application/json
required

password object that you want to change

userId
integer <int32>
emailId
string
oldPassword
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "emailId": "string",
  • "oldPassword": "string",
  • "newPassword": "string"
}

Reset forgot password

API used to reset forgot password

Request Body schema: application/json
required

EmailUser object for which password has to reset

userId
integer <int32>
username
string
emailId
string
token
string
password
string
hashPassword
string

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "username": "string",
  • "emailId": "string",
  • "token": "string",
  • "password": "string",
  • "hashPassword": "string"
}

Confirm Forgot Password

API used to confirm if forgot password token is valid

Request Body schema: application/json
required

EmailUser object for which token has to validate

userId
integer <int32>
username
string
emailId
string
token
string
password
string
hashPassword
string

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "username": "string",
  • "emailId": "string",
  • "token": "string",
  • "password": "string",
  • "hashPassword": "string"
}

Map Access Control to User

API used to map access controls like realmCountry, organisation, healthArea and program with specified user

Request Body schema: application/json
required

user object for which access control need to map with

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
userId
integer <int32>
username
string
password
string
emailId
string
orgAndCountry
string
object (Realm)
Array of objects (Role)
roles
Array of strings
object (Language)
defaultModuleId
integer <int32>
faildAttempts
integer <int32>
lastLoginDate
string <date-time>
Array of objects (UserAcl)
Array of objects (UserAcl)
businessFunctionList
Array of strings
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "userId": 0,
  • "username": "string",
  • "password": "string",
  • "emailId": "string",
  • "orgAndCountry": "string",
  • "realm": {
    },
  • "roleList": [
    ],
  • "roles": [
    ],
  • "language": {
    },
  • "defaultModuleId": 0,
  • "faildAttempts": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "userAclList": [
    ],
  • "userAcls": [
    ],
  • "businessFunctionList": [
    ],
  • "baseModel": {
    }
}

tracerCategory

Get TracerCategory for a TracerCategoryId

API used to get the TracerCategory for a specific TracerCategoryId

path Parameters
tracerCategoryId
required
integer <int32>

TracerCategoryId that you want to the TracerCategory for

Responses

Get TracerCategory list

API used to get the complete TracerCategory list.

Responses

Update TracerCategory

API used to update a TracerCategory

Request Body schema: application/json
required

The TracerCategory object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
tracerCategoryId
integer <int32>
object (SimpleCodeObject)
object (SimpleCodeObject)
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "tracerCategoryId": 0,
  • "realm": {
    },
  • "healthArea": {
    },
  • "label": {
    },
  • "baseModel": {
    }
}

Add TracerCategory

API used to add a TracerCategory

Request Body schema: application/json
required

The TracerCategory object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
tracerCategoryId
integer <int32>
object (SimpleCodeObject)
object (SimpleCodeObject)
object (Label)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "tracerCategoryId": 0,
  • "realm": {
    },
  • "healthArea": {
    },
  • "label": {
    },
  • "baseModel": {
    }
}

Get TracerCategory list for Realm

API used to get the complete TracerCategory list for a Realm

path Parameters
realmId
required
integer <int32>

RealmId that you want the TracerCategory list for

Responses

Get TracerCategory list for Realm and Program

API used to get the complete TracerCategory list for a Realm and Program

path Parameters
realmId
required
integer <int32>

RealmId that you want the TracerCategory list for

programId
required
integer <int32>

ProgramId that you want the TracerCategory list for

Responses

Get TracerCategory list for Realm and active ProgramPlanningUnits

API used to get the TracerCategory list for a Realm. Only returns those Tracer Categories that are from Planning Units in active Programs

path Parameters
realmId
required
integer <int32>

RealmId that you want the TracerCategory list for

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

treeTemplate

Get active TreeTemplate list

API used to get the complete TreeTemplate list. Will only return those TreeTemplates that are marked Active.

Responses

Update TreeTemplate

API used to update a TreeTemplate

Request Body schema: application/json
required

The treeTemplate object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
treeTemplateId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (SimpleObjectWithType)
monthsInPast
integer <int32>
monthsInFuture
integer <int32>
notes
string
Array of objects (TreeLevel)
Array of objects (ForecastNodeTreeNode)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "treeTemplateId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "forecastMethod": {
    },
  • "monthsInPast": 0,
  • "monthsInFuture": 0,
  • "notes": "string",
  • "levelList": [
    ],
  • "flatList": [
    ],
  • "baseModel": {
    }
}

Add TreeTemplate

API used to add a TreeTemplate

Request Body schema: application/json
required

The TreeTemplate object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
treeTemplateId
integer <int32>
object (SimpleCodeObject)
object (Label)
object (SimpleObjectWithType)
monthsInPast
integer <int32>
monthsInFuture
integer <int32>
notes
string
Array of objects (TreeLevel)
Array of objects (ForecastNodeTreeNode)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "treeTemplateId": 0,
  • "realm": {
    },
  • "label": {
    },
  • "forecastMethod": {
    },
  • "monthsInPast": 0,
  • "monthsInFuture": 0,
  • "notes": "string",
  • "levelList": [
    ],
  • "flatList": [
    ],
  • "baseModel": {
    }
}

Get TreeTemplate based on the Id

API used to get a specific TreeTemplate based on the Id.

path Parameters
treeTemplateId
required
integer <int32>

treeTemplateId that you want to TreeTemplate list for

Responses

Get complete TreeTemplate list

API used to get the complete TreeTemplate list.

Responses

unit

Get Unit for a UnitId

API used to get the Unit for a specific UnitId

path Parameters
unitId
required
integer <int32>

UnitId that you want to the Unit for

Responses

Get Unit list

API used to get the complete Unit list.

Responses

Update Unit

API used to update a Unit

Request Body schema: application/json
required

The Unit object that you want to update

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
unitId
integer <int32>
object (Label)
unitCode
string
object (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "unitId": 0,
  • "label": {
    },
  • "unitCode": "string",
  • "dimension": {
    },
  • "baseModel": {
    }
}

Add Unit

API used to add a Unit

Request Body schema: application/json
required

The Unit object that you want to add

object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
unitId
integer <int32>
object (Label)
unitCode
string
object (SimpleObject)
object (BaseModel)

Responses

Request samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "unitId": 0,
  • "label": {
    },
  • "unitCode": "string",
  • "dimension": {
    },
  • "baseModel": {
    }
}

Get unit list by dimensionId

API used to get unit list by providing dimensionId

path Parameters
dimensionId
required
integer <int32>

dimensionId that you want to the unit list for

Responses

usagePeriod

Get active UsagePeriod list

API used to get the complete UsagePeriod list. Will only return those UsagePeriods that are marked Active.

Responses

Add or Update UsagePeriod

API used to add or update UsagePeriod

Request Body schema: application/json
required

The list of UsagePeriod objects that you want to add or update. If usagePeriodId is null or 0 then it is added if usagePeriodId is not null and non 0 it is updated

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
usagePeriodId
integer <int32>
object (Label)
convertToMonth
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get complete UsagePeriod list

API used to get the complete UsagePeriod list.

Responses

usageTemplate

Get active UsageTemplate list

API used to get the complete UsageTemplate list. Will only return those UsageTemplates that are marked Active.

Responses

Add or Update UsageTemplate

API used to add or update UsageTemplate

Request Body schema: application/json
required

The list of UsageTemplate objects that you want to add or update. If usageTemplateId is null or 0 then it is added if usageTemplateId is not null and non 0 it is updated

Array
object (BasicUser)
createdDate
string <date-time>
object (BasicUser)
lastModifiedDate
string <date-time>
active
boolean
usageTemplateId
integer <int32>
object (Label)
realmId
integer <int32>
object (SimpleCodeObject)
object (SimpleUnitObject)
object (SimpleCodeObject)
object (SimpleObject)
lagInMonths
integer <int32>
object (SimpleObject)
noOfPatients
integer <int32>
noOfForecastingUnits
integer <int32>
oneTimeUsage
boolean
object (UsagePeriod)
usageFrequencyCount
number <double>
object (UsagePeriod)
repeatCount
number <double>
notes
string
object (Label)
noOfFUPerPersonPerTime
number <double>
noOfFUPerPersonPerMonth
number <double>
noOfFURequired
number <double>
object (BaseModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get complete UsageTemplate list

API used to get the complete UsageTemplate list.

Responses

Get active UsageTemplate list

API used to get the complete UsageTemplate list. Will only return those UsageTemplates that are marked Active.

path Parameters
tracerCategoryId
required
integer <int32>

The TracerCategory that you want to filter the UsageTemplate

Responses

userManual

Upload UserManual

API used to upload UserManual

Request Body schema: application/json

User manual file to upload

file
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}